Skip to content

Add maintainer onboarding and release guidance - #1529

Merged
bmehta001 merged 9 commits into
microsoft:mainfrom
bmehta001:bhamehta/maintainer-onboarding-guide
Sep 24, 2026
Merged

bmehta001 merged 9 commits into
microsoft:mainfrom
bmehta001:bhamehta/maintainer-onboarding-guide

Conversation

@bmehta001

Copy link
Copy Markdown
Contributor

Summary

  • add a central maintainer onboarding guide with repository reading order and development workflow
  • document Windows, WSL/Linux, vcpkg, Android, macOS, iOS, simulator, physical-device, and end-to-end Kusto validation
  • document PR expectations and the complete SDK, SPM, vcpkg, and downstream release process
  • replace obsolete version schedules with the current four-component version and support policy
  • link the new guidance from the README

Validation

  • ran the repository's pinned misspell checker on all changed Markdown files
  • checked whitespace errors with git diff --check
  • verified relative links introduced by the new and rewritten documentation

Centralize build, validation, PR, and release practices so maintainers can follow one current operational guide.

Files changed:
- README.md
- docs/maintainer-onboarding.md
- docs/versioning.md

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot-Session: a7d76f00-9675-4f19-9639-118e0d3dab4e
@bmehta001
bmehta001 requested a review from a team as a code owner September 1, 2026 18:37
Avoid overstating Mac Catalyst and visionOS support while documenting the SPM xcframework slices available for evaluation.

Files changed:
- README.md

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot-Session: a7d76f00-9675-4f19-9639-118e0d3dab4e
@bmehta001 bmehta001 self-assigned this Sep 8, 2026
Comment thread docs/maintainer-onboarding.md
bmehta001 and others added 2 commits September 22, 2026 02:48
docs/maintainer-onboarding.md: guide maintainers to review non-gating leak warnings and avoid unsupported Windows compatibility work.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The guide is useful and most commands match the repository. I found three documentation issues that should be corrected before approval.

Comment thread docs/maintainer-onboarding.md
Comment thread docs/maintainer-onboarding.md Outdated
Comment thread docs/maintainer-onboarding.md
bmehta001 and others added 2 commits September 24, 2026 02:16
Make tools/gen-version.sh run relative to its script directory so documented root invocations work.

Clarify the SPM X.Y.Z collision for fourth-component-only corrections in docs/maintainer-onboarding.md and docs/versioning.md; verified against .github/workflows/spm-release.yml.

The leak-workflow link already resolves in the merged main at a387a25; no separate fix is needed.

Files changed: tools/gen-version.sh, docs/maintainer-onboarding.md, docs/versioning.md.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@bmehta001
bmehta001 enabled auto-merge (squash) September 24, 2026 07:23
Move the wrapped configuration from file scope to a per-instance owning pointer, preventing later copies from redirecting earlier wrappers and leaking prior allocations.

Files: wrappers/obj-c/ODWLogConfiguration.mm, wrappers/obj-c/ODWLogConfiguration_private.h, tests/unittests/obj-c/ODWLogConfigurationTests.mm

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot-Session: a668528d-5dc9-4648-a753-95c0235cc103
Check presence through HasConfig rather than converting an unset Variant to a string; this preserves the regression assertion without crashing debug iOS tests.

Files: tests/unittests/obj-c/ODWLogConfigurationTests.mm

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot-Session: a668528d-5dc9-4648-a753-95c0235cc103
@bmehta001
bmehta001 merged commit 9dd3283 into microsoft:main Sep 24, 2026
53 checks passed
@bmehta001
bmehta001 deleted the bhamehta/maintainer-onboarding-guide branch September 24, 2026 16:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants